Payment Initiation APIs 4.0
Payment Consents Examples
This section provides examples of requests and responses for the individual Payment Consents APIs:
Domestic Payment Consents APIs
POST request: domestic payment consents request
This API endpoint allows the PISP to ask an ASPSP to create a new domestic payment consent resource. The POST action indicates to the ASPSP that a domestic payment consent has been staged. At this point, the PSU may not have been identified by the ASPSP, and the request payload may not contain any information of the account that should be debited.
The endpoint allows the PISP to send a copy of the consent (between PSU and PISP) to the ASPSP for the PSU to authorize. The ASPSP creates the domestic payment consent resource and responds with a unique Consent ID to refer to the resource.
POST /domestic-payment-consents HTTP/1.1
curl -X POST \
https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/pisp/domestic-payment-consents/
-H 'Authorization: Bearer VS6VAWqqfI2sKOh4iuwgEgPPgduw' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date': Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '{
"Data": {
"ReadRefundAccount": "Yes",
"Initiation": {
"InstructionIdentification": "ACME412",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE37IRCE92050112345679",
"Name": "ACME Inc",
"SecondaryIdentification": "0002",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE",
"Type": "Telephone"
}
},
"CreditorPostalAddress": {
"AddressLine": [
"Acacia Lodge",
"Flat 7"
],
"Country": "GB"
},
"UltimateDebtor": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "2360549017905161589",
"Name": "Ultimate Debtor",
"LEI": "8200007YHFDMEODY1965",
"PostalAddress": {
"AddressType": "BIZZ",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingName": "Tower Bridges",
"BuildingNumber": "11",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"CareOf": "Jane Smith",
"PostBox": "PO Box 123456",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CountrySubDivision": "England",
"Country": "GB"
}
},
"CreditorAgent": {
"LEI": "8200007YHFDMEODY1965",
"SchemeName": "UK.OBIE.BICFI",
"Identification": "80200112344562",
"Name": "The Credit Agent",
"PostalAddress": {
"AddressType": "BIZZ",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingName": "Tower Bridges",
"BuildingNumber": "11",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"CareOf": "Jane Smith",
"PostBox": "PO Box 123456",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CountrySubDivision": "England",
"Country": "UK"
}
},
"UltimateCreditor": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "2360549017905161589",
"Name": "Ultimate Creditor",
"LEI": "60450004FECVJV7YN339",
"PostalAddress": {
"AddressType": "BIZZ",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingName": "Tower Bridges",
"BuildingNumber": "11",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"CareOf": "Jane Smith",
"PostBox": "PO Box 123456PO",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CountrySubDivision": "England",
"Country": "GB"
}
},
"RegulatoryReporting": [
{
"DebitCreditReportingIndicator": "CRED",
"Authority": {
"Name": "string",
"CountryCode": "UG"
},
"Details": [
{
"Type": "CRED",
"Date": "2026-04-25T13:26:41.911Z",
"Information": [
"Reg info1",
"Reg info2"
],
"Country": "QG",
"Amount": {
"Amount": "4.68702",
"Currency": "EUR"
}
}
]
}
],
"RemittanceInformation": {
"Structured": [
{
"ReferredDocumentInformation": [
{
"Code": "DISP",
"Issuer": "Issuer01",
"Number": "Number_01",
"RelatedDate": "2026-04-25T13:26:41.911Z",
"LineDetails": [
"LineDetail"
]
}
],
"ReferredDocumentAmount": 1,
"CreditorReferenceInformation": {
"Code": "DISP",
"Issuer": "Issuer01",
"Reference": "REF_26518"
},
"Invoicer": "INVR51856",
"Invoicee": "INVE5161856",
"TaxRemittance": "Tax Remittance related information",
"AdditionalRemittanceInformation": [
"Free text for additional information"
]
}
],
"Unstructured": [
"Internal ops code 5120101"
]
}
}
},
"Risk": {
"PaymentContextCode": "EcommerceMerchantInitiatedPayment",
"ContractPresentIndicator": false,
"BeneficiaryPrepopulatedIndicator": false,
"PaymentPurposeCode": "RVPO",
"CategoryPurposeCode": "CASH",
"BeneficiaryAccountType": "Business",
"MerchantCategoryCode": "7300",
"MerchantCustomerIdentification": "053598653254",
"DeliveryAddress": {
"AddressType": "BIZZ",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingName": "Tower Bridges",
"BuildingNumber": "11",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"CareOf": "Jane Smith",
"PostBox": "PO Box 123456",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CountrySubDivision": "England",
"Country": "GB"
}
}
}Header parameters :
| Parameter | Example value | Description |
|---|---|---|
| authorization | Bearer yncA2hqqUbR8Wf86J3plfw2o5A4d | The token obtained in step 1(Get access token). |
| x-jws-signature | TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw== | Header containing a detached JWS of the payload. Mandatory for requests that contain a payload. Please refer to the processes of generating one here. |
POST response: domestic payment consents
HTTP/1.1 201 Created
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODIwOSwiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..UzSO4Yw97FrpdpoxwOWqYPpi3kftH-wMclXXhh-2jpJc3hqPzQFkgyovr3uciTUGClY88DknV-ZwhyO3DJitboEX6su8K1REbLbtnX22EXmj1LIw9WYNYSmmf2D5TobHSzRvIsToUg-Tn2v7tl6asmjGYh1HUBF4JUUwgcrBiwlUBELNT_wlpXMe5lDpAcpDnXHYkvR2bZkcu995BEu31rCn4QppTxU7Aq82c0XuRsiOABuGExYbJWh55cSlVCBXt7ZKlGTf2ypXTFeeoDK48-ves6bOJYoTKQ8ywMkJf38tgtDsXdIpbwFT3rBTB6_N70F_DgM-dvCGj2jvS0PB9A
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"ConsentId": "e266ebb0-8183-4110-9a70-9cf5903d7994",
"CreationDateTime": "2026-06-12T12:38:25+00:00",
"Status": "AWAU",
"StatusReason": [
{
"StatusReasonCode": "U036",
"StatusReasonDescription": "Authorisation not completed"
}
],
"StatusUpdateDateTime": "2026-06-12T12:38:25+00:00",
"ReadRefundAccount": "Yes",
"CutOffDateTime": "2026-06-15T12:38:25+00:00",
"ExpectedExecutionDateTime": "2026-06-13T12:38:25+00:00",
"ExpectedSettlementDateTime": "2026-06-14T12:38:25+00:00",
"Charges": [
{
"ChargeBearer": "FollowingServiceLevel",
"Type": "Type1",
"Amount": {
"Amount": "3.00",
"Currency": "GBP"
}
}
],
"Initiation": {
"InstructionIdentification": "ACME412",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "EUR"
},
"CreditorAgent": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "80200112344562",
"Name": "The Credit Agent",
"LEI": "8200007YHFDMEODY1965",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "UK",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE37IRCE92050112345679",
"Name": "ACME Inc",
"SecondaryIdentification": "0002",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE",
"Type": "Telephone"
}
},
"CreditorPostalAddress": {
"Country": "GB",
"AddressLine": [
"Acacia Lodge",
"Flat 7"
]
},
"UltimateCreditor": {
"Name": "Ultimate Creditor",
"Identification": "2360549017905161589",
"LEI": "60450004FECVJV7YN339",
"SchemeName": "UK.OBIE.IBAN",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456PO",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"UltimateDebtor": {
"Name": "Ultimate Debtor",
"Identification": "2360549017905161589",
"LEI": "8200007YHFDMEODY1965",
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"RegulatoryReporting": [
{
"DebitCreditReportingIndicator": "CRED",
"Authority": {
"Name": "string",
"CountryCode": "UG"
},
"Details": [
{
"Type": "CRED",
"Date": "2026-04-25T13:26:41.911Z",
"Country": "QG",
"Amount": {
"Amount": "4.68702",
"Currency": "EUR"
},
"Information": [
"Reg info1",
"Reg info2"
]
}
]
}
],
"RemittanceInformation": {
"Structured": [
{
"ReferredDocumentInformation": [
{
"Code": "DISP",
"Issuer": "Issuer01",
"Number": "Number_01",
"RelatedDate": "2026-04-25T13:26:41.911Z",
"LineDetails": [
"LineDetail"
]
}
],
"ReferredDocumentAmount": 1,
"CreditorReferenceInformation": {
"Code": "DISP",
"Issuer": "Issuer01",
"Reference": "REF_26518"
},
"Invoicer": "INVR51856",
"Invoicee": "INVE5161856",
"TaxRemittance": "Tax Remittance related information",
"AdditionalRemittanceInformation": [
"Free text for additional information"
]
}
],
"Unstructured": [
"Internal ops code 5120101"
]
}
},
"Debtor": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "90883965880313",
"Name": "Grey Chappel",
"SecondaryIdentification": "BIC92661819"
}
},
"Risk": {
"PaymentContextCode": "EcommerceMerchantInitiatedPayment",
"MerchantCategoryCode": "7300",
"MerchantCustomerIdentification": "053598653254",
"ContractPresentIndicator": false,
"BeneficiaryPrepopulatedIndicator": false,
"PaymentPurposeCode": "RVPO",
"CategoryPurposeCode": "CASH",
"BeneficiaryAccountType": "Business",
"DeliveryAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"Links": {
"Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/pisp/domestic-payment-consents/e266ebb0-8183-4110-9a70-9cf5903d7994"
},
"Meta": {}
}GET request: domestic payment consents
A PISP can optionally retrieve a payment consent resource that they have created to check its status. The available status codes for the domestic payment consent resource are:
| Status | Description |
|---|---|
| AWAU | Before the PSU authorises the payment-consent resource |
| RJCT | If the PSU rejects the consent or the domestic-payment-consent has failed some other ASPSP validation |
| AUTH | Once the PSU authorises the payment-consent resource |
| COND | Once a domestic-payment has been successfully created using the domestic-payment-consent |
GET /domestic-payment-consents/ e266ebb0-8183-4110-9a70-9cf5903d7994 HTTP/1.1
curl -X GET \
(https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/pisp/domestic-payment-consents/e266ebb0-8183-4110-9a70-9cf5903d7994\)
-H 'Authorization: Bearer MSdQrRyLqftG6NbSfOdSGntgPeTQ' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date': Sun, 10 Sep 2017 19:43:31 UTC'
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.21 ' \
GET response: domestic payment consents
HTTP/1.1 200 OK
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODU4MCwiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..S9-ZingkHVC0WgDujBxQmztpuI-Fbr-qCYZU7iqGuYWADXMDPhP4_XO_tb5geTGdAT6JADDM9LaOG0J038ax1nPvT0MZMKYJ7mW7eiX8ZKtcwPWFMVlJLvYhG0lYSEJwNcuV0nkQQjVeqeCjiLM8CqkTmfVgdOdayAQgGgMEkxGRKsvX3ED8JWmqHuiiDlH-jrMjK-YtLf_QlUHV_WN-mHSywXJIJHpZFLMUO2bL59QgMcyIl5UuGJBPQCmpvAEGcHQSKGbOIJfJCAYyZREhs9ZoLbqIClJ7eUAbZO8h70u6aah2_pb0pv-b-yDSODb_Twot6_phQ-zOJI32RK87yg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"ConsentId": "e266ebb0-8183-4110-9a70-9cf5903d7994",
"CreationDateTime": "2026-06-12T12:38:25+00:00",
"Status": "AWAU",
"StatusReason": [
{
"StatusReasonCode": "U036",
"StatusReasonDescription": "Authorisation not completed"
}
],
"StatusUpdateDateTime": "2026-06-12T12:38:25+00:00",
"ReadRefundAccount": "Yes",
"CutOffDateTime": "2026-06-15T12:38:25+00:00",
"ExpectedExecutionDateTime": "2026-06-13T12:38:25+00:00",
"ExpectedSettlementDateTime": "2026-06-14T12:38:25+00:00",
"Charges": [
{
"ChargeBearer": "FollowingServiceLevel",
"Type": "Type1",
"Amount": {
"Amount": "3.00",
"Currency": "GBP"
}
}
],
"Initiation": {
"InstructionIdentification": "ACME412",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "EUR"
},
"CreditorAgent": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "80200112344562",
"Name": "The Credit Agent",
"LEI": "8200007YHFDMEODY1965",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "UK",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE37IRCE92050112345679",
"Name": "ACME Inc",
"SecondaryIdentification": "0002",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE",
"Type": "Telephone"
}
},
"CreditorPostalAddress": {
"Country": "GB",
"AddressLine": [
"Acacia Lodge",
"Flat 7"
]
},
"UltimateCreditor": {
"Name": "Ultimate Creditor",
"Identification": "2360549017905161589",
"LEI": "60450004FECVJV7YN339",
"SchemeName": "UK.OBIE.IBAN",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456PO",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"UltimateDebtor": {
"Name": "Ultimate Debtor",
"Identification": "2360549017905161589",
"LEI": "8200007YHFDMEODY1965",
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"RegulatoryReporting": [
{
"DebitCreditReportingIndicator": "CRED",
"Authority": {
"Name": "string",
"CountryCode": "UG"
},
"Details": [
{
"Type": "CRED",
"Date": "2026-04-25T13:26:41.911Z",
"Country": "QG",
"Amount": {
"Amount": "4.68702",
"Currency": "EUR"
},
"Information": [
"Reg info1",
"Reg info2"
]
}
]
}
],
"RemittanceInformation": {
"Structured": [
{
"ReferredDocumentInformation": [
{
"Code": "DISP",
"Issuer": "Issuer01",
"Number": "Number_01",
"RelatedDate": "2026-04-25T13:26:41.911Z",
"LineDetails": [
"LineDetail"
]
}
],
"ReferredDocumentAmount": 1,
"CreditorReferenceInformation": {
"Code": "DISP",
"Issuer": "Issuer01",
"Reference": "REF_26518"
},
"Invoicer": "INVR51856",
"Invoicee": "INVE5161856",
"TaxRemittance": "Tax Remittance related information",
"AdditionalRemittanceInformation": [
"Free text for additional information"
]
}
],
"Unstructured": [
"Internal ops code 5120101"
]
}
},
"Debtor": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "90883965880313",
"Name": "Grey Chappel",
"SecondaryIdentification": "BIC92661819"
}
},
"Risk": {
"PaymentContextCode": "EcommerceMerchantInitiatedPayment",
"MerchantCategoryCode": "7300",
"MerchantCustomerIdentification": "053598653254",
"ContractPresentIndicator": false,
"BeneficiaryPrepopulatedIndicator": false,
"PaymentPurposeCode": "RVPO",
"CategoryPurposeCode": "CASH",
"BeneficiaryAccountType": "Business",
"DeliveryAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"Links": {
"Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/pisp/domestic-payment-consents/e266ebb0-8183-4110-9a70-9cf5903d7994"
},
"Meta": {}
}Get Request: Confirm Funds on Domestic Payment Order Consent
GET /domestic-payment-consents/58923/funds-confirmation HTTP/1.1
Authorization: Bearer Jhingapulaav
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/jsonGet Response: Confirm Funds on Domestic Payment Order Consent
HTTP/1.1 200 OK
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"FundsAvailableResult": {
"FundsAvailableDateTime": "2026-06-12T12:38:25+00:00",
"FundsAvailable": true
}
},
"Links": {
"Self": "https://api.alphabank.com/open-banking/v4.0/pisp/domestic-payment-consents/58923/funds-confirmation"
},
"Meta": {}
}Domestic Payment Consents (CHAPS Payment) APIs
POST request: CHAPS domestic payment consents request
POST /domestic-payment-consents HTTP/1.1
curl -X POST \
https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/pisp/domestic-payment-consents/
-H 'Authorization: Bearer VS6VAWqqfI2sKOh4iuwgEgPPgduw' \
-H 'Content-Type: application/json' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date': Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '{
"Data": {
"ReadRefundAccount": "Yes",
"Initiation": {
"InstructionIdentification": "ACME412",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"LocalInstrument": "UK.OBIE.CHAPS",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "GBP"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325698",
"Name": "ACME Inc",
"SecondaryIdentification": "0002",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE",
"Type": "Telephone"
}
},
"CreditorPostalAddress": {
"AddressLine": [
"Acacia Lodge",
"Flat 7"
],
"Country": "GB"
},
"UltimateDebtor": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "2360549017905161589",
"Name": "Ultimate Debtor",
"LEI": "8200007YHFDMEODY1965",
"PostalAddress": {
"AddressType": "BIZZ",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingName": "Tower Bridges",
"BuildingNumber": "11",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"CareOf": "Jane Smith",
"PostBox": "PO Box 123456",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CountrySubDivision": "England",
"Country": "GB"
}
},
"CreditorAgent": {
"LEI": "8200007YHFDMEODY1965",
"SchemeName": "UK.OBIE.BICFI",
"Identification": "80200112344562",
"Name": "The Credit Agent",
"PostalAddress": {
"AddressType": "BIZZ",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingName": "Tower Bridges",
"BuildingNumber": "11",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"CareOf": "Jane Smith",
"PostBox": "PO Box 123456",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CountrySubDivision": "England",
"Country": "UK"
}
},
"UltimateCreditor": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "2360549017905161589",
"Name": "Ultimate Creditor",
"LEI": "60450004FECVJV7YN339",
"PostalAddress": {
"AddressType": "BIZZ",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingName": "Tower Bridges",
"BuildingNumber": "11",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"CareOf": "Jane Smith",
"PostBox": "PO Box 123456PO",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CountrySubDivision": "England",
"Country": "GB"
}
},
"RegulatoryReporting": [
{
"DebitCreditReportingIndicator": "CRED",
"Authority": {
"Name": "string",
"CountryCode": "UG"
},
"Details": [
{
"Type": "CRED",
"Date": "2026-04-25T13:26:41.911Z",
"Information": [
"Reg info1",
"Reg info2"
],
"Country": "QG",
"Amount": {
"Amount": "4.68702",
"Currency": "EUR"
}
}
]
}
],
"RemittanceInformation": {
"Structured": [
{
"ReferredDocumentInformation": [
{
"Code": "DISP",
"Issuer": "Issuer01",
"Number": "Number_01",
"RelatedDate": "2026-04-25T13:26:41.911Z",
"LineDetails": [
"LineDetail"
]
}
],
"ReferredDocumentAmount": 1,
"CreditorReferenceInformation": {
"Code": "DISP",
"Issuer": "Issuer01",
"Reference": "REF_26518"
},
"Invoicer": "INVR51856",
"Invoicee": "INVE5161856",
"TaxRemittance": "Tax Remittance related information",
"AdditionalRemittanceInformation": [
"Free text for additional information"
]
}
],
"Unstructured": [
"Internal ops code 5120101"
]
}
}
},
"Risk": {
"PaymentContextCode": "EcommerceMerchantInitiatedPayment",
"ContractPresentIndicator": false,
"BeneficiaryPrepopulatedIndicator": false,
"PaymentPurposeCode": "RVPO",
"CategoryPurposeCode": "CASH",
"BeneficiaryAccountType": "Business",
"MerchantCategoryCode": "7300",
"MerchantCustomerIdentification": "053598653254",
"DeliveryAddress": {
"AddressType": "BIZZ",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingName": "Tower Bridges",
"BuildingNumber": "11",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"CareOf": "Jane Smith",
"PostBox": "PO Box 123456",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CountrySubDivision": "England",
"Country": "GB"
}
}
}POST Response: CHAPS domestic payment consent
HTTP/1.1 201 Created
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODIwOSwiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..UzSO4Yw97FrpdpoxwOWqYPpi3kftH-wMclXXhh-2jpJc3hqPzQFkgyovr3uciTUGClY88DknV-ZwhyO3DJitboEX6su8K1REbLbtnX22EXmj1LIw9WYNYSmmf2D5TobHSzRvIsToUg-Tn2v7tl6asmjGYh1HUBF4JUUwgcrBiwlUBELNT_wlpXMe5lDpAcpDnXHYkvR2bZkcu995BEu31rCn4QppTxU7Aq82c0XuRsiOABuGExYbJWh55cSlVCBXt7ZKlGTf2ypXTFeeoDK48-ves6bOJYoTKQ8ywMkJf38tgtDsXdIpbwFT3rBTB6_N70F_DgM-dvCGj2jvS0PB9A
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"ConsentId": "e2a7c4e5-32cd-4ba4-bdfa-c2141f6fe441",
"CreationDateTime": "2026-06-12T13:41:44+00:00",
"Status": "AWAU",
"StatusReason": [
{
"StatusReasonCode": "U036",
"StatusReasonDescription": "Authorisation not completed"
}
],
"StatusUpdateDateTime": "2026-06-12T13:41:44+00:00",
"ReadRefundAccount": "Yes",
"CutOffDateTime": "2026-06-15T13:41:44+00:00",
"ExpectedExecutionDateTime": "2026-06-13T13:41:44+00:00",
"ExpectedSettlementDateTime": "2026-06-14T13:41:44+00:00",
"Charges": [
{
"ChargeBearer": "FollowingServiceLevel",
"Type": "Type1",
"Amount": {
"Amount": "3.00",
"Currency": "GBP"
}
}
],
"Initiation": {
"InstructionIdentification": "ACME412",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"LocalInstrument": "UK.OBIE.CHAPS",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "EUR"
},
"CreditorAgent": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "80200112344562",
"Name": "The Credit Agent",
"LEI": "8200007YHFDMEODY1965",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "UK",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325698",
"Name": "ACME Inc",
"SecondaryIdentification": "0002",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE",
"Type": "Telephone"
}
},
"CreditorPostalAddress": {
"Country": "GB",
"AddressLine": [
"Acacia Lodge",
"Flat 7"
]
},
"UltimateCreditor": {
"Name": "Ultimate Creditor",
"Identification": "2360549017905161589",
"LEI": "60450004FECVJV7YN339",
"SchemeName": "UK.OBIE.IBAN",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456PO",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"UltimateDebtor": {
"Name": "Ultimate Debtor",
"Identification": "2360549017905161589",
"LEI": "8200007YHFDMEODY1965",
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"RegulatoryReporting": [
{
"DebitCreditReportingIndicator": "CRED",
"Authority": {
"Name": "string",
"CountryCode": "UG"
},
"Details": [
{
"Type": "CRED",
"Date": "2026-04-25T13:26:41.911Z",
"Country": "QG",
"Amount": {
"Amount": "4.68702",
"Currency": "EUR"
},
"Information": [
"Reg info1",
"Reg info2"
]
}
]
}
],
"RemittanceInformation": {
"Structured": [
{
"ReferredDocumentInformation": [
{
"Code": "DISP",
"Issuer": "Issuer01",
"Number": "Number_01",
"RelatedDate": "2026-04-25T13:26:41.911Z",
"LineDetails": [
"LineDetail"
]
}
],
"ReferredDocumentAmount": 1,
"CreditorReferenceInformation": {
"Code": "DISP",
"Issuer": "Issuer01",
"Reference": "REF_26518"
},
"Invoicer": "INVR51856",
"Invoicee": "INVE5161856",
"TaxRemittance": "Tax Remittance related information",
"AdditionalRemittanceInformation": [
"Free text for additional information"
]
}
],
"Unstructured": [
"Internal ops code 5120101"
]
}
},
"Debtor": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "90883965880313",
"Name": "Grey Chappel",
"SecondaryIdentification": "BIC92661819"
}
},
"Risk": {
"PaymentContextCode": "EcommerceMerchantInitiatedPayment",
"MerchantCategoryCode": "7300",
"MerchantCustomerIdentification": "053598653254",
"ContractPresentIndicator": false,
"BeneficiaryPrepopulatedIndicator": false,
"PaymentPurposeCode": "RVPO",
"CategoryPurposeCode": "CASH",
"BeneficiaryAccountType": "Business",
"DeliveryAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"Links": {
"Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/pisp/domestic-payment-consents/e2a7c4e5-32cd-4ba4-bdfa-c2141f6fe441"
},
"Meta": {}
}Domestic Payment Consents (SDMT Payment) APIs
POST request: SDMT domestic payment consents request
POST /domestic-payment-consents HTTP/1.1
curl -X POST \
https://api-sandbox.bankofireland.com/1/api/open-banking/v4.0/pisp/domestic-payment-consents/
-H 'Authorization: Bearer VS6VAWqqfI2sKOh4iuwgEgPPgduw' \
-H 'Content-Type: application/json' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date': Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '
{
"Data": {
"ReadRefundAccount": "Yes",
"Initiation": {
"InstructionIdentification": "ACME412",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"LocalInstrument": "UK.OBIE.Target2",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE37IRCE92050112345679",
"Name": "ACME Inc",
"SecondaryIdentification": "0002",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE",
"Type": "Telephone"
}
},
"CreditorPostalAddress": {
"AddressLine": [
"Acacia Lodge",
"Flat 7"
],
"Country": "GB"
},
"UltimateDebtor": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "2360549017905161589",
"Name": "Ultimate Debtor",
"LEI": "8200007YHFDMEODY1965",
"PostalAddress": {
"AddressType": "BIZZ",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingName": "Tower Bridges",
"BuildingNumber": "11",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"CareOf": "Jane Smith",
"PostBox": "PO Box 123456",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CountrySubDivision": "England",
"Country": "GB"
}
},
"CreditorAgent": {
"LEI": "8200007YHFDMEODY1965",
"SchemeName": "UK.OBIE.BICFI",
"Identification": "80200112344562",
"Name": "The Credit Agent",
"PostalAddress": {
"AddressType": "BIZZ",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingName": "Tower Bridges",
"BuildingNumber": "11",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"CareOf": "Jane Smith",
"PostBox": "PO Box 123456",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CountrySubDivision": "England",
"Country": "UK"
}
},
"UltimateCreditor": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "2360549017905161589",
"Name": "Ultimate Creditor",
"LEI": "60450004FECVJV7YN339",
"PostalAddress": {
"AddressType": "BIZZ",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingName": "Tower Bridges",
"BuildingNumber": "11",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"CareOf": "Jane Smith",
"PostBox": "PO Box 123456PO",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CountrySubDivision": "England",
"Country": "GB"
}
},
"RegulatoryReporting": [
{
"DebitCreditReportingIndicator": "CRED",
"Authority": {
"Name": "string",
"CountryCode": "UG"
},
"Details": [
{
"Type": "CRED",
"Date": "2026-04-25T13:26:41.911Z",
"Information": [
"Reg info1",
"Reg info2"
],
"Country": "QG",
"Amount": {
"Amount": "4.68702",
"Currency": "EUR"
}
}
]
}
],
"RemittanceInformation": {
"Structured": [
{
"ReferredDocumentInformation": [
{
"Code": "DISP",
"Issuer": "Issuer01",
"Number": "Number_01",
"RelatedDate": "2026-04-25T13:26:41.911Z",
"LineDetails": [
"LineDetail"
]
}
],
"ReferredDocumentAmount": 1,
"CreditorReferenceInformation": {
"Code": "DISP",
"Issuer": "Issuer01",
"Reference": "REF_26518"
},
"Invoicer": "INVR51856",
"Invoicee": "INVE5161856",
"TaxRemittance": "Tax Remittance related information",
"AdditionalRemittanceInformation": [
"Free text for additional information"
]
}
],
"Unstructured": [
"Internal ops code 5120101"
]
}
}
},
"Risk": {
"PaymentContextCode": "EcommerceMerchantInitiatedPayment",
"ContractPresentIndicator": false,
"BeneficiaryPrepopulatedIndicator": false,
"PaymentPurposeCode": "RVPO",
"CategoryPurposeCode": "CASH",
"BeneficiaryAccountType": "Business",
"MerchantCategoryCode": "7300",
"MerchantCustomerIdentification": "053598653254",
"DeliveryAddress": {
"AddressType": "BIZZ",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingName": "Tower Bridges",
"BuildingNumber": "11",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"CareOf": "Jane Smith",
"PostBox": "PO Box 123456",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CountrySubDivision": "England",
"Country": "GB"
}
}
}POST response: SDMT domestic payment consents
HTTP/1.1 201 Created
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODIwOSwiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..UzSO4Yw97FrpdpoxwOWqYPpi3kftH-wMclXXhh-2jpJc3hqPzQFkgyovr3uciTUGClY88DknV-ZwhyO3DJitboEX6su8K1REbLbtnX22EXmj1LIw9WYNYSmmf2D5TobHSzRvIsToUg-Tn2v7tl6asmjGYh1HUBF4JUUwgcrBiwlUBELNT_wlpXMe5lDpAcpDnXHYkvR2bZkcu995BEu31rCn4QppTxU7Aq82c0XuRsiOABuGExYbJWh55cSlVCBXt7ZKlGTf2ypXTFeeoDK48-ves6bOJYoTKQ8ywMkJf38tgtDsXdIpbwFT3rBTB6_N70F_DgM-dvCGj2jvS0PB9A
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"ConsentId": "83e1ec1a-8f13-46b5-9ca3-30386dfcd68c",
"CreationDateTime": "2026-06-12T14:05:24+00:00",
"Status": "AWAU",
"StatusReason": [
{
"StatusReasonCode": "U036",
"StatusReasonDescription": "Authorisation not completed"
}
],
"StatusUpdateDateTime": "2026-06-12T14:05:24+00:00",
"ReadRefundAccount": "Yes",
"CutOffDateTime": "2026-06-15T14:05:24+00:00",
"ExpectedExecutionDateTime": "2026-06-13T14:05:24+00:00",
"ExpectedSettlementDateTime": "2026-06-14T14:05:24+00:00",
"Charges": [
{
"ChargeBearer": "FollowingServiceLevel",
"Type": "Type1",
"Amount": {
"Amount": "3.00",
"Currency": "GBP"
}
}
],
"Initiation": {
"InstructionIdentification": "ACME412",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"LocalInstrument": "UK.OBIE.Target2",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "EUR"
},
"CreditorAgent": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "80200112344562",
"Name": "The Credit Agent",
"LEI": "8200007YHFDMEODY1965",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "UK",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE37IRCE92050112345679",
"Name": "ACME Inc",
"SecondaryIdentification": "0002",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE",
"Type": "Telephone"
}
},
"CreditorPostalAddress": {
"Country": "GB",
"AddressLine": [
"Acacia Lodge",
"Flat 7"
]
},
"UltimateCreditor": {
"Name": "Ultimate Creditor",
"Identification": "2360549017905161589",
"LEI": "60450004FECVJV7YN339",
"SchemeName": "UK.OBIE.IBAN",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456PO",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"UltimateDebtor": {
"Name": "Ultimate Debtor",
"Identification": "2360549017905161589",
"LEI": "8200007YHFDMEODY1965",
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"RegulatoryReporting": [
{
"DebitCreditReportingIndicator": "CRED",
"Authority": {
"Name": "string",
"CountryCode": "UG"
},
"Details": [
{
"Type": "CRED",
"Date": "2026-04-25T13:26:41.911Z",
"Country": "QG",
"Amount": {
"Amount": "4.68702",
"Currency": "EUR"
},
"Information": [
"Reg info1",
"Reg info2"
]
}
]
}
],
"RemittanceInformation": {
"Structured": [
{
"ReferredDocumentInformation": [
{
"Code": "DISP",
"Issuer": "Issuer01",
"Number": "Number_01",
"RelatedDate": "2026-04-25T13:26:41.911Z",
"LineDetails": [
"LineDetail"
]
}
],
"ReferredDocumentAmount": 1,
"CreditorReferenceInformation": {
"Code": "DISP",
"Issuer": "Issuer01",
"Reference": "REF_26518"
},
"Invoicer": "INVR51856",
"Invoicee": "INVE5161856",
"TaxRemittance": "Tax Remittance related information",
"AdditionalRemittanceInformation": [
"Free text for additional information"
]
}
],
"Unstructured": [
"Internal ops code 5120101"
]
}
},
"Debtor": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "90883965880313",
"Name": "Grey Chappel",
"SecondaryIdentification": "BIC92661819"
}
},
"Risk": {
"PaymentContextCode": "EcommerceMerchantInitiatedPayment",
"MerchantCategoryCode": "7300",
"MerchantCustomerIdentification": "053598653254",
"ContractPresentIndicator": false,
"BeneficiaryPrepopulatedIndicator": false,
"PaymentPurposeCode": "RVPO",
"CategoryPurposeCode": "CASH",
"BeneficiaryAccountType": "Business",
"DeliveryAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"Links": {
"Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/pisp/domestic-payment-consents/83e1ec1a-8f13-46b5-9ca3-30386dfcd68c"
},
"Meta": {}
}Domestic scheduled payment consents API
POST request: domestic scheduled payment consents
curl -X POST \
https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/pisp/domestic-scheduled-payment-consents/
-H 'Authorization: Bearer VS6VAWqqfI2sKOh4iuwgEgPPgduw' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date': Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.22' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '{
"Data": {
"Permission": "Create",
"ReadRefundAccount": "Yes",
"Authorisation": {
"AuthorisationType": "Any"
},
"Initiation": {
"InstructionIdentification": "ACME412",
"RequestedExecutionDateTime": "2026-06-20T00:00:00+00:00",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"InstructedAmount": {
"Amount": "700",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE37IRCE92050112345679",
"Name": "ACMEInc",
"SecondaryIdentification": "0002",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE",
"Type": "Telephone"
}
},
"CreditorPostalAddress": {
"AddressLine": [
"Flat7",
"AcaciaLodge"
],
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"PostCode": "Z784TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"CountrySubDivision": "England",
"Country": "GB"
},
"UltimateDebtor": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "2360549017905161589",
"Name": "UltimateDebtor",
"LEI": "8200007YHFDMEODY1965",
"PostalAddress": {
"AddressLine": [
"Flat7",
"AcaciaLodge"
],
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"PostCode": "Z784TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"CountrySubDivision": "England",
"Country": "UK"
}
},
"UltimateCreditor": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "2360549017905161589",
"Name": "UltimateCreditor",
"LEI": "60450004FECVJV7YN339",
"PostalAddress": {
"AddressLine": [
"Flat7",
"AcaciaLodge"
],
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"PostCode": "Z784TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"CountrySubDivision": "England",
"Country": "UK"
}
},
"RegulatoryReporting": [
{
"DebitCreditReportingIndicator": "CRED",
"Authority": {
"Name": "CG",
"CountryCode": "UG"
},
"Details": [
{
"Type": "CRED",
"Date": "2026-04-25T13:26:41.911Z",
"Information": [
"Reginfo1",
"Reginfo2"
],
"Country": "QG",
"Amount": {
"Amount": "4.68702",
"Currency": "EUR"
}
}
]
}
],
"RemittanceInformation": {
"Structured": [
{
"ReferredDocumentInformation": [
{
"Code": "CINV",
"Issuer": "Issuer01",
"Number": "Number_01",
"RelatedDate": "2026-04-25T13:26:41.911Z",
"LineDetails": [
"LineDetail"
]
}
],
"ReferredDocumentAmount": 1,
"CreditorReferenceInformation": {
"Code": "DISP",
"Issuer": "Issuer01",
"Reference": "REF_26518"
},
"Invoicer": "INVR51856",
"Invoicee": "INVE5161856",
"TaxRemittance": "TaxRemittancerelatedinformation",
"AdditionalRemittanceInformation": [
"Freetextforadditionalinformation"
]
}
],
"Unstructured": [
"Internalopscode5120101"
]
}
}
},
"Risk": {
"ContractPresentIndicator": false,
"BeneficiaryPrepopulatedIndicator": false,
"PaymentPurposeCode": "BOCE",
"CategoryPurposeCode": "CASH",
"BeneficiaryAccountType": "Business",
"MerchantCategoryCode": "7300",
"MerchantCustomerIdentification": "053598653254",
"DeliveryAddress": {
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CareOf": "Ms Jane Smith",
"CountrySubDivision": "England",
"Country": "GB"
}
}
}This API endpoint allows the PISP to ask BOI to create a new domestic scheduled payment consents resource and the API responds with a unique Consent ID to refer to the resource.
POST response:domestic scheduled payment consents
HTTP/1.1 201 Created
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODIwOSwiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..UzSO4Yw97FrpdpoxwOWqYPpi3kftH-wMclXXhh-2jpJc3hqPzQFkgyovr3uciTUGClY88DknV-ZwhyO3DJitboEX6su8K1REbLbtnX22EXmj1LIw9WYNYSmmf2D5TobHSzRvIsToUg-Tn2v7tl6asmjGYh1HUBF4JUUwgcrBiwlUBELNT_wlpXMe5lDpAcpDnXHYkvR2bZkcu995BEu31rCn4QppTxU7Aq82c0XuRsiOABuGExYbJWh55cSlVCBXt7ZKlGTf2ypXTFeeoDK48-ves6bOJYoTKQ8ywMkJf38tgtDsXdIpbwFT3rBTB6_N70F_DgM-dvCGj2jvS0PB9A
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"ConsentId": "5db8c3ee-e5d6-4b1c-8362-5d59ff57311d",
"CreationDateTime": "2026-08-11T04:56:46+00:00",
"Status": "AWAU",
"StatusUpdateDateTime": "2026-08-11T04:56:46+00:00",
"StatusReason": [
{
"StatusReasonCode": "U036",
"StatusReasonDescription": "Authorisation not completed"
}
],
"Permission": "Create",
"ReadRefundAccount": "Yes",
"CutOffDateTime": "2026-08-14T04:56:46+00:00",
"ExpectedExecutionDateTime": "2026-08-12T04:56:46+00:00",
"ExpectedSettlementDateTime": "2026-08-13T04:56:46+00:00",
"Initiation": {
"InstructionIdentification": "ACME412",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"RequestedExecutionDateTime": "2026-08-20T00:00:00+00:00",
"InstructedAmount": {
"Amount": "700",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE37IRCE92050112345679",
"Name": "ACMEInc",
"SecondaryIdentification": "0002",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE",
"Type": "Telephone"
}
},
"CreditorPostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"TownLocationName": "Bank",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"PostCode": "Z784TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat7",
"AcaciaLodge"
]
},
"UltimateCreditor": {
"Name": "UltimateCreditor",
"Identification": "2360549017905161589",
"LEI": "60450004FECVJV7YN339",
"SchemeName": "UK.OBIE.IBAN",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"TownLocationName": "Bank",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"PostCode": "Z784TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "UK",
"AddressLine": [
"Flat7",
"AcaciaLodge"
]
}
},
"UltimateDebtor": {
"Name": "UltimateDebtor",
"Identification": "2360549017905161589",
"LEI": "8200007YHFDMEODY1965",
"SchemeName": "UK.OBIE.IBAN",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"TownLocationName": "Bank",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"PostCode": "Z784TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "UK",
"AddressLine": [
"Flat7",
"AcaciaLodge"
]
}
},
"RegulatoryReporting": [
{
"DebitCreditReportingIndicator": "CRED",
"Authority": {
"Name": "CG",
"CountryCode": "UG"
},
"Details": [
{
"Type": "CRED",
"Date": "2026-04-25T13:26:41.911Z",
"Country": "QG",
"Amount": {
"Amount": "4.68702",
"Currency": "EUR"
},
"Information": [
"Reginfo1",
"Reginfo2"
]
}
]
}
],
"RemittanceInformation": {
"Structured": [
{
"ReferredDocumentInformation": [
{
"Code": "CINV",
"Issuer": "Issuer01",
"Number": "Number_01",
"RelatedDate": "2026-04-25T13:26:41.911Z",
"LineDetails": [
"LineDetail"
]
}
],
"ReferredDocumentAmount": 1,
"CreditorReferenceInformation": {
"Code": "DISP",
"Issuer": "Issuer01",
"Reference": "REF_26518"
},
"Invoicer": "INVR51856",
"Invoicee": "INVE5161856",
"TaxRemittance": "TaxRemittancerelatedinformation",
"AdditionalRemittanceInformation": [
"Freetextforadditionalinformation"
]
}
],
"Unstructured": [
"Internalopscode5120101"
]
}
},
"Authorisation": {
"AuthorisationType": "Any"
},
"Debtor": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "GR9608100010000001234567890",
"Name": "Greg Maguire",
"SecondaryIdentification": "BIC92661819"
}
},
"Risk": {
"MerchantCategoryCode": "7300",
"MerchantCustomerIdentification": "053598653254",
"ContractPresentIndicator": false,
"BeneficiaryPrepopulatedIndicator": false,
"PaymentPurposeCode": "BOCE",
"CategoryPurposeCode": "CASH",
"BeneficiaryAccountType": "Business",
"DeliveryAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Ms Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"Links": {
"Self": " https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/pisp/domestic-scheduled-payment-consents/ 5db8c3ee-e5d6-4b1c-8362-5d59ff57311d”
},
"Meta": {}
}Domestic Schedule Payment consents (CHAPS Payment)API
POST request: CHAPS domestic scheduled payment consents
curl -X POST \
https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/pisp/domestic-scheduled-payment-consents/
-H 'Authorization: Bearer VS6VAWqqfI2sKOh4iuwgEgPPgduw' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date': Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.22' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '
{
"Data": {
"Permission": "Create",
"ReadRefundAccount": "Yes",
"Authorisation": {
"AuthorisationType": "Any"
},
"Initiation": {
"InstructionIdentification": "ACME412",
"RequestedExecutionDateTime": "2026-06-20T00:00:00+00:00",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"LocalInstrument": "UK.OBIE.CHAPS",
"InstructedAmount": {
"Amount": "700.00",
"Currency": "GBP"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325698",
"Name": "ACMEInc",
"SecondaryIdentification": "0002",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE",
"Type": "Telephone"
}
},
"CreditorPostalAddress": {
"AddressLine": [
"Flat7",
"AcaciaLodge"
],
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"PostCode": "Z784TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"CountrySubDivision": "England",
"Country": "GB"
},
"UltimateDebtor": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "2360549017905161589",
"Name": "UltimateDebtor",
"LEI": "8200007YHFDMEODY1965",
"PostalAddress": {
"AddressLine": [
"Flat7",
"AcaciaLodge"
],
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"PostCode": "Z784TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"CountrySubDivision": "England",
"Country": "UK"
}
},
"UltimateCreditor": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "2360549017905161589",
"Name": "UltimateCreditor",
"LEI": "60450004FECVJV7YN339",
"PostalAddress": {
"AddressLine": [
"Flat7",
"AcaciaLodge"
],
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"PostCode": "Z784TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"CountrySubDivision": "England",
"Country": "UK"
}
},
"RegulatoryReporting": [
{
"DebitCreditReportingIndicator": "CRED",
"Authority": {
"Name": "CG",
"CountryCode": "UG"
},
"Details": [
{
"Type": "CRED",
"Date": "2026-04-25T13:26:41.911Z",
"Information": [
"Reginfo1",
"Reginfo2"
],
"Country": "QG",
"Amount": {
"Amount": "4.68702",
"Currency": "EUR"
}
}
]
}
],
"RemittanceInformation": {
"Structured": [
{
"ReferredDocumentInformation": [
{
"Code": "CINV",
"Issuer": "Issuer01",
"Number": "Number_01",
"RelatedDate": "2026-04-25T13:26:41.911Z",
"LineDetails": [
"LineDetail"
]
}
],
"ReferredDocumentAmount": 1,
"CreditorReferenceInformation": {
"Code": "DISP",
"Issuer": "Issuer01",
"Reference": "REF_26518"
},
"Invoicer": "INVR51856",
"Invoicee": "INVE5161856",
"TaxRemittance": "TaxRemittancerelatedinformation",
"AdditionalRemittanceInformation": [
"Freetextforadditionalinformation"
]
}
],
"Unstructured": [
"Internalopscode5120101"
]
}
}
},
"Risk": {
"ContractPresentIndicator": false,
"BeneficiaryPrepopulatedIndicator": false,
"PaymentPurposeCode": "BOCE",
"CategoryPurposeCode": "CASH",
"BeneficiaryAccountType": "Business",
"MerchantCategoryCode": "7300",
"MerchantCustomerIdentification": "053598653254",
"DeliveryAddress": {
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CareOf": "Ms Jane Smith",
"CountrySubDivision": "England",
"Country": "GB"
}
}
}This API endpoint allows the PISP to ask BOI to create a new domestic scheduled payment consents resource and the API responds with a unique Consent ID to refer to the resource.
POST response: CHAPS domestic scheduled payment consents
HTTP/1.1 201 Created
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODIwOSwiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..UzSO4Yw97FrpdpoxwOWqYPpi3kftH-wMclXXhh-2jpJc3hqPzQFkgyovr3uciTUGClY88DknV-ZwhyO3DJitboEX6su8K1REbLbtnX22EXmj1LIw9WYNYSmmf2D5TobHSzRvIsToUg-Tn2v7tl6asmjGYh1HUBF4JUUwgcrBiwlUBELNT_wlpXMe5lDpAcpDnXHYkvR2bZkcu995BEu31rCn4QppTxU7Aq82c0XuRsiOABuGExYbJWh55cSlVCBXt7ZKlGTf2ypXTFeeoDK48-ves6bOJYoTKQ8ywMkJf38tgtDsXdIpbwFT3rBTB6_N70F_DgM-dvCGj2jvS0PB9A
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"ConsentId": "737ae8fc-f3cd-41b5-a5c6-bb58bffeeda8",
"CreationDateTime": "2026-06-15T08:30:40+00:00",
"Status": "AWAU",
"StatusUpdateDateTime": "2026-06-15T08:30:40+00:00",
"StatusReason": [
{
"StatusReasonCode": "U036",
"StatusReasonDescription": "Authorisation not completed"
}
],
"Permission": "Create",
"ReadRefundAccount": "Yes",
"CutOffDateTime": "2026-06-18T08:30:40+00:00",
"ExpectedExecutionDateTime": "2026-06-16T08:30:40+00:00",
"ExpectedSettlementDateTime": "2026-06-17T08:30:40+00:00",
"Initiation": {
"InstructionIdentification": "ACME412",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"LocalInstrument": "UK.OBIE.CHAPS",
"RequestedExecutionDateTime": "2026-06-20T00:00:00+00:00",
"InstructedAmount": {
"Amount": "700.00",
"Currency": "GBP"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325698",
"Name": "ACMEInc",
"SecondaryIdentification": "0002",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE",
"Type": "Telephone"
}
},
"CreditorPostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"TownLocationName": "Bank",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"PostCode": "Z784TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat7",
"AcaciaLodge"
]
},
"UltimateCreditor": {
"Name": "UltimateCreditor",
"Identification": "2360549017905161589",
"LEI": "60450004FECVJV7YN339",
"SchemeName": "UK.OBIE.IBAN",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"TownLocationName": "Bank",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"PostCode": "Z784TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "UK",
"AddressLine": [
"Flat7",
"AcaciaLodge"
]
}
},
"UltimateDebtor": {
"Name": "UltimateDebtor",
"Identification": "2360549017905161589",
"LEI": "8200007YHFDMEODY1965",
"SchemeName": "UK.OBIE.IBAN",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"TownLocationName": "Bank",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"PostCode": "Z784TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "UK",
"AddressLine": [
"Flat7",
"AcaciaLodge"
]
}
},
"RegulatoryReporting": [
{
"DebitCreditReportingIndicator": "CRED",
"Authority": {
"Name": "CG",
"CountryCode": "UG"
},
"Details": [
{
"Type": "CRED",
"Date": "2026-04-25T13:26:41.911Z",
"Country": "QG",
"Amount": {
"Amount": "4.68702",
"Currency": "EUR"
},
"Information": [
"Reginfo1",
"Reginfo2"
]
}
]
}
],
"RemittanceInformation": {
"Structured": [
{
"ReferredDocumentInformation": [
{
"Code": "CINV",
"Issuer": "Issuer01",
"Number": "Number_01",
"RelatedDate": "2026-04-25T13:26:41.911Z",
"LineDetails": [
"LineDetail"
]
}
],
"ReferredDocumentAmount": 1,
"CreditorReferenceInformation": {
"Code": "DISP",
"Issuer": "Issuer01",
"Reference": "REF_26518"
},
"Invoicer": "INVR51856",
"Invoicee": "INVE5161856",
"TaxRemittance": "TaxRemittancerelatedinformation",
"AdditionalRemittanceInformation": [
"Freetextforadditionalinformation"
]
}
],
"Unstructured": [
"Internalopscode5120101"
]
}
},
"Authorisation": {
"AuthorisationType": "Any"
},
"Debtor": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "90883965880313",
"Name": "Greg Chappel",
"SecondaryIdentification": "BIC92661819"
}
},
"Risk": {
"MerchantCategoryCode": "7300",
"MerchantCustomerIdentification": "053598653254",
"ContractPresentIndicator": false,
"BeneficiaryPrepopulatedIndicator": false,
"PaymentPurposeCode": "BOCE",
"CategoryPurposeCode": "CASH",
"BeneficiaryAccountType": "Business",
"DeliveryAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Ms Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"Links": {
"Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/pisp/domestic-scheduled-payment-consents/737ae8fc-f3cd-41b5-a5c6-bb58bffeeda8"
},
"Meta": {}
}Domestic Scheduled Payment consents (SDMT Payment) API
POST request: SDMT domestic scheduled payment consents
curl -X POST \
https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/pisp/domestic-scheduled-payment-consents/
-H 'Authorization: Bearer VS6VAWqqfI2sKOh4iuwgEgPPgduw' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date': Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.22' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '
{
"Data": {
"Permission": "Create",
"ReadRefundAccount": "Yes",
"Authorisation": {
"AuthorisationType": "Any"
},
"Initiation": {
"InstructionIdentification": "ACME412",
"RequestedExecutionDateTime": "2026-06-20T00:00:00+00:00",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"LocalInstrument": "UK.OBIE.Target2",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE37IRCE92050112345679",
"Name": "ACMEInc",
"SecondaryIdentification": "0002",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE",
"Type": "Telephone"
}
},
"CreditorPostalAddress": {
"AddressLine": [
"Flat7",
"AcaciaLodge"
],
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"PostCode": "Z784TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"CountrySubDivision": "England",
"Country": "GB"
},
"UltimateDebtor": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "2360549017905161589",
"Name": "UltimateDebtor",
"LEI": "8200007YHFDMEODY1965",
"PostalAddress": {
"AddressLine": [
"Flat7",
"AcaciaLodge"
],
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"PostCode": "Z784TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"CountrySubDivision": "England",
"Country": "UK"
}
},
"UltimateCreditor": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "2360549017905161589",
"Name": "UltimateCreditor",
"LEI": "60450004FECVJV7YN339",
"PostalAddress": {
"AddressLine": [
"Flat7",
"AcaciaLodge"
],
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"PostCode": "Z784TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"CountrySubDivision": "England",
"Country": "UK"
}
},
"RegulatoryReporting": [
{
"DebitCreditReportingIndicator": "CRED",
"Authority": {
"Name": "CG",
"CountryCode": "UG"
},
"Details": [
{
"Type": "CRED",
"Date": "2026-04-25T13:26:41.911Z",
"Information": [
"Reginfo1",
"Reginfo2"
],
"Country": "QG",
"Amount": {
"Amount": "4.68702",
"Currency": "EUR"
}
}
]
}
],
"RemittanceInformation": {
"Structured": [
{
"ReferredDocumentInformation": [
{
"Code": "CINV",
"Issuer": "Issuer01",
"Number": "Number_01",
"RelatedDate": "2026-04-25T13:26:41.911Z",
"LineDetails": [
"LineDetail"
]
}
],
"ReferredDocumentAmount": 1,
"CreditorReferenceInformation": {
"Code": "DISP",
"Issuer": "Issuer01",
"Reference": "REF_26518"
},
"Invoicer": "INVR51856",
"Invoicee": "INVE5161856",
"TaxRemittance": "TaxRemittancerelatedinformation",
"AdditionalRemittanceInformation": [
"Freetextforadditionalinformation"
]
}
],
"Unstructured": [
"Internalopscode5120101"
]
}
}
},
"Risk": {
"ContractPresentIndicator": false,
"BeneficiaryPrepopulatedIndicator": false,
"PaymentPurposeCode": "BOCE",
"CategoryPurposeCode": "CASH",
"BeneficiaryAccountType": "Business",
"MerchantCategoryCode": "7300",
"MerchantCustomerIdentification": "053598653254",
"DeliveryAddress": {
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CareOf": "Ms Jane Smith",
"CountrySubDivision": "England",
"Country": "GB"
}
}
}This API endpoint allows the PISP to ask BOI to create a new domestic scheduled payment consents resource and the API responds with a unique Consent ID to refer to the resource.
POST response: SDMT domestic scheduled payment consents
HTTP/1.1 201 Created
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODIwOSwiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..UzSO4Yw97FrpdpoxwOWqYPpi3kftH-wMclXXhh-2jpJc3hqPzQFkgyovr3uciTUGClY88DknV-ZwhyO3DJitboEX6su8K1REbLbtnX22EXmj1LIw9WYNYSmmf2D5TobHSzRvIsToUg-Tn2v7tl6asmjGYh1HUBF4JUUwgcrBiwlUBELNT_wlpXMe5lDpAcpDnXHYkvR2bZkcu995BEu31rCn4QppTxU7Aq82c0XuRsiOABuGExYbJWh55cSlVCBXt7ZKlGTf2ypXTFeeoDK48-ves6bOJYoTKQ8ywMkJf38tgtDsXdIpbwFT3rBTB6_N70F_DgM-dvCGj2jvS0PB9A
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"ConsentId": "c13875df-186a-4b68-95c5-a854103526a0",
"CreationDateTime": "2026-06-15T08:43:01+00:00",
"Status": "AWAU",
"StatusUpdateDateTime": "2026-06-15T08:43:01+00:00",
"StatusReason": [
{
"StatusReasonCode": "U036",
"StatusReasonDescription": "Authorisation not completed"
}
],
"Permission": "Create",
"ReadRefundAccount": "Yes",
"CutOffDateTime": "2026-06-18T08:43:01+00:00",
"ExpectedExecutionDateTime": "2026-06-16T08:43:01+00:00",
"ExpectedSettlementDateTime": "2026-06-17T08:43:01+00:00",
"Initiation": {
"InstructionIdentification": "ACME412",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"LocalInstrument": "UK.OBIE.Target2",
"RequestedExecutionDateTime": "2026-06-20T00:00:00+00:00",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE37IRCE92050112345679",
"Name": "ACMEInc",
"SecondaryIdentification": "0002",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE",
"Type": "Telephone"
}
},
"CreditorPostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"TownLocationName": "Bank",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"PostCode": "Z784TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat7",
"AcaciaLodge"
]
},
"UltimateCreditor": {
"Name": "UltimateCreditor",
"Identification": "2360549017905161589",
"LEI": "60450004FECVJV7YN339",
"SchemeName": "UK.OBIE.IBAN",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"TownLocationName": "Bank",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"PostCode": "Z784TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "UK",
"AddressLine": [
"Flat7",
"AcaciaLodge"
]
}
},
"UltimateDebtor": {
"Name": "UltimateDebtor",
"Identification": "2360549017905161589",
"LEI": "8200007YHFDMEODY1965",
"SchemeName": "UK.OBIE.IBAN",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "BankStreet",
"BuildingNumber": "11",
"BuildingName": "TowerBridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "POBox123456",
"TownLocationName": "Bank",
"DistrictName": "GreaterLondon",
"CareOf": "MsJaneSmith",
"PostCode": "Z784TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "UK",
"AddressLine": [
"Flat7",
"AcaciaLodge"
]
}
},
"RegulatoryReporting": [
{
"DebitCreditReportingIndicator": "CRED",
"Authority": {
"Name": "CG",
"CountryCode": "UG"
},
"Details": [
{
"Type": "CRED",
"Date": "2026-04-25T13:26:41.911Z",
"Country": "QG",
"Amount": {
"Amount": "4.68702",
"Currency": "EUR"
},
"Information": [
"Reginfo1",
"Reginfo2"
]
}
]
}
],
"RemittanceInformation": {
"Structured": [
{
"ReferredDocumentInformation": [
{
"Code": "CINV",
"Issuer": "Issuer01",
"Number": "Number_01",
"RelatedDate": "2026-04-25T13:26:41.911Z",
"LineDetails": [
"LineDetail"
]
}
],
"ReferredDocumentAmount": 1,
"CreditorReferenceInformation": {
"Code": "DISP",
"Issuer": "Issuer01",
"Reference": "REF_26518"
},
"Invoicer": "INVR51856",
"Invoicee": "INVE5161856",
"TaxRemittance": "TaxRemittancerelatedinformation",
"AdditionalRemittanceInformation": [
"Freetextforadditionalinformation"
]
}
],
"Unstructured": [
"Internalopscode5120101"
]
}
},
"Authorisation": {
"AuthorisationType": "Any"
},
"Debtor": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "90883965880313",
"Name": "Greg Chappel",
"SecondaryIdentification": "BIC92661819"
}
},
"Risk": {
"MerchantCategoryCode": "7300",
"MerchantCustomerIdentification": "053598653254",
"ContractPresentIndicator": false,
"BeneficiaryPrepopulatedIndicator": false,
"PaymentPurposeCode": "BOCE",
"CategoryPurposeCode": "CASH",
"BeneficiaryAccountType": "Business",
"DeliveryAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Ms Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"Links": {
"Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/pisp/domestic-scheduled-payment-consents/c13875df-186a-4b68-95c5-a854103526a0"
},
"Meta": {}
}Domestic standing order consents API
POST request:domestic standing order consents
curl -X POST \
https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/pisp/domestic-standing-order-consents/
-H 'Authorization: Bearer VS6VAWqqfI2sKOh4iuwgEgPPgduw' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.23' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '
{
"Data": {
"ReadRefundAccount": "Yes",
"Permission": "Create",
"Authorisation": {
"AuthorisationType": "Single"
},
"Initiation": {
"FirstPaymentAmount": {
"Amount": "300",
"Currency": "GBP"
},
"RecurringPaymentAmount": {
"Amount": "7.00",
"Currency": "GBP"
},
"FinalPaymentAmount": {
"Amount": "7.00",
"Currency": "GBP"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325698",
"Name": "ACME Inc",
"SecondaryIdentification": "0002",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE",
"Type": "Telephone"
}
},
"MandateRelatedInformation": {
"MandateIdentification": "SO-003538282",
"Classification": "FIXE",
"CategoryPurposeCode": "CASH",
"FirstPaymentDateTime": "2026-05-24T16:33:53.087Z",
"FinalPaymentDateTime": "2026-09-04T16:33:53.087Z",
"Frequency": {
"Type": "DAIL",
"CountPerPeriod": 1
},
"Reason": "Pocket Money"
},
"UltimateDebtor": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "2360549017905161589",
"Name": "Ultimate Debtor",
"LEI": "8200007YHFDMEODY1965",
"PostalAddress": {
"AddressType": "BIZZ",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingName": "Tower Bridges",
"BuildingNumber": "11",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"CareOf": "Jane Smith",
"PostBox": "PO Box 123456",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CountrySubDivision": "England",
"Country": "GB"
}
},
"UltimateCreditor": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "2360549017905161589",
"Name": "Ultimate Creditor",
"LEI": "60450004FECVJV7YN339",
"PostalAddress": {
"AddressType": "BIZZ",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingName": "Tower Bridges",
"BuildingNumber": "11",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"CareOf": "Jane Smith",
"PostBox": "PO Box 123456PO",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CountrySubDivision": "England",
"Country": "GB"
}
},
"RegulatoryReporting": [
{
"DebitCreditReportingIndicator": "CRED",
"Authority": {
"Name": "string",
"CountryCode": "UG"
},
"Details": [
{
"Type": "CRED",
"Date": "2026-04-25T13:26:41.911Z",
"Information": [
"Reg info1"
],
"Country": "QG",
"Amount": {
"Amount": "4.68702",
"Currency": "EUR"
}
}
]
}
],
"RemittanceInformation": {
"Structured": [
{
"ReferredDocumentInformation": [
{
"Code": "DISP",
"Issuer": "Issuer01",
"Number": "Number_01",
"RelatedDate": "2026-04-25T13:26:41.911Z",
"LineDetails": [
"LineDetail"
]
}
],
"ReferredDocumentAmount": 1,
"CreditorReferenceInformation": {
"Code": "DISP",
"Issuer": "Issuer01",
"Reference": "REF_26518"
},
"Invoicer": "INVR51856",
"Invoicee": "INVE5161856",
"TaxRemittance": "Tax Remittance related information",
"AdditionalRemittanceInformation": [
"Free text for additional information"
]
}
],
"Unstructured": [
"Internal ops code 5120101"
]
}
}
},
"Risk": {
"PaymentContextCode": "EcommerceMerchantInitiatedPayment",
"ContractPresentIndicator": false,
"BeneficiaryPrepopulatedIndicator": false,
"PaymentPurposeCode": "RVPO",
"CategoryPurposeCode": "CASH",
"BeneficiaryAccountType": "Business",
"MerchantCategoryCode": "7300",
"MerchantCustomerIdentification": "053598653254",
"DeliveryAddress": {
"AddressType": "BIZZ",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingName": "Tower Bridges",
"BuildingNumber": "11",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"CareOf": "Jane Smith",
"PostBox": "PO Box 123456",
"PostCode": "Z78 4TY",
"TownLocationName": "Bank",
"TownName": "London",
"DistrictName": "Greater London",
"CountrySubDivision": "England",
"Country": "GB"
}
}
}This API endpoint allows the PISP to ask BOI to create a new domestic standing order consents resource and the API responds with a unique Consent ID to refer to the resource.
POST response:domestic standing order consents
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODU4MCwiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..S9-ZingkHVC0WgDujBxQmztpuI-Fbr-qCYZU7iqGuYWADXMDPhP4_XO_tb5geTGdAT6JADDM9LaOG0J038ax1nPvT0MZMKYJ7mW7eiX8ZKtcwPWFMVlJLvYhG0lYSEJwNcuV0nkQQjVeqeCjiLM8CqkTmfVgdOdayAQgGgMEkxGRKsvX3ED8JWmqHuiiDlH-jrMjK-YtLf_QlUHV_WN-mHSywXJIJHpZFLMUO2bL59QgMcyIl5UuGJBPQCmpvAEGcHQSKGbOIJfJCAYyZREhs9ZoLbqIClJ7eUAbZO8h70u6aah2_pb0pv-b-yDSODb_Twot6_phQ-zOJI32RK87yg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"ConsentId": "1720aa32-439d-4340-b02e-a6f9a9b69423",
"CreationDateTime": "2026-06-12T14:22:28+00:00",
"Status": "AWAU",
"StatusUpdateDateTime": "2026-06-12T14:22:28+00:00",
"StatusReason": [
{
"StatusReasonCode": "U036",
"StatusReasonDescription": "Authorisation not completed"
}
],
"Permission": "Create",
"ReadRefundAccount": "Yes",
"CutOffDateTime": "2026-06-15T14:22:28+00:00",
"Initiation": {
"RemittanceInformation": {
"Structured": [
{
"ReferredDocumentInformation": [
{
"Code": "DISP",
"Issuer": "Issuer01",
"Number": "Number_01",
"RelatedDate": "2026-04-25T13:26:41.911Z",
"LineDetails": [
"LineDetail"
]
}
],
"ReferredDocumentAmount": 1,
"CreditorReferenceInformation": {
"Code": "DISP",
"Issuer": "Issuer01",
"Reference": "REF_26518"
},
"Invoicer": "INVR51856",
"Invoicee": "INVE5161856",
"TaxRemittance": "Tax Remittance related information",
"AdditionalRemittanceInformation": [
"Free text for additional information"
]
}
],
"Unstructured": [
"Internal ops code 5120101"
]
},
"FirstPaymentAmount": {
"Amount": "300",
"Currency": "GBP"
},
"RecurringPaymentAmount": {
"Amount": "7.00",
"Currency": "GBP"
},
"FinalPaymentAmount": {
"Amount": "7.00",
"Currency": "GBP"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325698",
"Name": "ACME Inc",
"SecondaryIdentification": "0002",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE",
"Type": "Telephone"
}
},
"UltimateCreditor": {
"Name": "Ultimate Creditor",
"Identification": "2360549017905161589",
"LEI": "60450004FECVJV7YN339",
"SchemeName": "UK.OBIE.IBAN",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456PO",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"UltimateDebtor": {
"Name": "Ultimate Debtor",
"Identification": "2360549017905161589",
"LEI": "8200007YHFDMEODY1965",
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"RegulatoryReporting": [
{
"DebitCreditReportingIndicator": "CRED",
"Authority": {
"Name": "string",
"CountryCode": "UG"
},
"Details": [
{
"Type": "CRED",
"Date": "2026-04-25T13:26:41.911Z",
"Country": "QG",
"Amount": {
"Amount": "4.68702",
"Currency": "EUR"
},
"Information": [
"Reg info1"
]
}
]
}
],
"MandateRelatedInformation": {
"MandateIdentification": "SO-003538282",
"Classification": "FIXE",
"CategoryPurposeCode": "CASH",
"FirstPaymentDateTime": "2026-05-24T16:33:53.087Z",
"FinalPaymentDateTime": "2026-09-04T16:33:53.087Z",
"Frequency": {
"Type": "DAIL",
"CountPerPeriod": 1
},
"Reason": "Pocket Money"
}
},
"Authorisation": {
"AuthorisationType": "Single"
},
"Debtor": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "90883965880313",
"Name": "Greg Chappel",
"SecondaryIdentification": "BIC92661819"
}
},
"Risk": {
"PaymentContextCode": "EcommerceMerchantInitiatedPayment",
"MerchantCategoryCode": "7300",
"MerchantCustomerIdentification": "053598653254",
"ContractPresentIndicator": false,
"BeneficiaryPrepopulatedIndicator": false,
"PaymentPurposeCode": "RVPO",
"CategoryPurposeCode": "CASH",
"BeneficiaryAccountType": "Business",
"DeliveryAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Tower Bridges",
"Floor": "6",
"UnitNumber": "UNIT591",
"Room": "844",
"PostBox": "PO Box 123456",
"TownLocationName": "Bank",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "Z78 4TY",
"TownName": "London",
"CountrySubDivision": "England",
"Country": "GB",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"Links": {
"Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/pisp/domestic-standing-order-consents/1720aa32-439d-4340-b02e-a6f9a9b69423"
},
"Meta": {}
}